--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
docs/start.html HEAD (1e25a629) Text, 7.14 KB
Tff7b72<!doctype html>
Tb4b4b4<Tff7b72htmlTb4b4b4>
Tb4b4b4<Tff7b72headTb4b4b4>
Tb4b4b4<Tff7b72link Te6edf3relTff7b72=Ta5d6ff"stylesheet" Te6edf3hrefTff7b72=Ta5d6ff"css/water.css?v=6"Tb4b4b4>
Tb4b4b4<Tff7b72meta Te6edf3charsetTff7b72=Ta5d6ff"utf-8"Tb4b4b4/Tb4b4b4>
Tb4b4b4<Tff7b72titleTb4b4b4>Reticulum NetworkTb4b4b4<Tb4b4b4/Tff7b72titleTb4b4b4>
Tb4b4b4<Tff7b72meta Te6edf3nameTff7b72=Ta5d6ff"viewport" Te6edf3contentTff7b72=Ta5d6ff"width=device-width, initial-scale=1.0"Tb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72headTb4b4b4>
Tb4b4b4<Tff7b72bodyTb4b4b4>
Tb4b4b4<Tff7b72centerTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>Tb4b4b4<Tff7b72span Te6edf3classTff7b72=Ta5d6ff"top_menu lang_menu"Tb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_de.html"Tb4b4b4>DeutschTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start.html"Tb4b4b4>EnglishTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_es.html"Tb4b4b4>EspañolTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_nl.html"Tb4b4b4>NederlandsTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_pl.html"Tb4b4b4>PolskiTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_pt-br.html"Tb4b4b4>PortuguêsTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_tr.html"Tb4b4b4>TürkçeTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_uk.html"Tb4b4b4>УкраїнськаTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_jp.html"Tb4b4b4>日本語Tb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"./start_zh-cn.html"Tb4b4b4>简体中文Tb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72spanTb4b4b4>Tb4b4b4<Tff7b72span Te6edf3classTff7b72=Ta5d6ff"top_menu"Tb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"index.html"Tb4b4b4>ReticulumTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"start.html"Tb4b4b4>StartTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"hardware.html"Tb4b4b4>HardwareTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"connect.html"Tb4b4b4>ConnectTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"docs.html"Tb4b4b4>ManualTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"crypto.html"Tb4b4b4>CryptographyTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"credits.html"Tb4b4b4>CreditsTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/markqvist/reticulum"Tb4b4b4>SourceTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> | Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"donate.html"Tb4b4b4>DonateTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72spanTb4b4b4>Tb4b4b4<Tff7b72brTb4b4b4/Tb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72centerTb4b4b4>
Tb4b4b4<Tff7b72h1Tb4b4b4>Get StartedTb4b4b4<Tb4b4b4/Tff7b72h1Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>The best way to get started with the Reticulum Network Stack depends on what you want to do.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>To understand the foundational philosophy and goals of this system, read the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"zenofreticulum.html"Tb4b4b4>Zen of ReticulumTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>For full details and examples, have a look at the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/gettingstartedfast.html"Tb4b4b4>Getting Started FastTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> section of the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/index.html"Tb4b4b4>Reticulum ManualTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72h2Tb4b4b4>InstallationTb4b4b4<Tb4b4b4/Tff7b72h2Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>To install Reticulum and related utilities on your system, the easiest way is via pip:Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72preTb4b4b4>Tb4b4b4<Tff7b72code Te6edf3classTff7b72=Ta5d6ff"language-bash"Tb4b4b4>pip install rns
Tb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72preTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>You can then start any program that uses Reticulum, or start Reticulum as a system service with Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/using.html#the-rnsd-utility"Tb4b4b4>the rnsd utilityTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>If Tb4b4b4<Tff7b72codeTb4b4b4>pipTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> is not available on your system, install the Tb4b4b4<Tff7b72codeTb4b4b4>python3Tb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> and Tb4b4b4<Tff7b72codeTb4b4b4>python3-pipTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> packages for your OS first.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally reachable. If any of those local peers are Transport Instances, these might connect you to wider networks. The default config file contains a few examples, and references for creating a more complex configuration.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>For more detailed examples on how to expand communication over many mediums such as packet radio or LoRa, serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces, take a look at the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/interfaces.html"Tb4b4b4>Supported InterfacesTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> section of the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/index.html"Tb4b4b4>Reticulum ManualTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72h2Tb4b4b4>Included UtilitiesTb4b4b4<Tb4b4b4/Tff7b72h2Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>Reticulum includes a range of useful utilities for managing your networks, viewing status and information, and other tasks. You can read more about these programs in the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/using.html#included-utility-programs"Tb4b4b4>Included Utility ProgramsTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> section of the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"manual/index.html"Tb4b4b4>Reticulum ManualTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>The system daemon Tb4b4b4<Tff7b72codeTb4b4b4>rnsdTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> for running Reticulum as an always-available serviceTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>An interface status utility called Tb4b4b4<Tff7b72codeTb4b4b4>rnstatusTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4>, that displays information about interfacesTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>The path lookup and management tool Tb4b4b4<Tff7b72codeTb4b4b4>rnpathTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> letting you view and modify path tablesTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>A diagnostics tool called Tb4b4b4<Tff7b72codeTb4b4b4>rnprobeTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> for checking connectivity to destinationsTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>A simple file transfer program called Tb4b4b4<Tff7b72codeTb4b4b4>rncpTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> making it easy to copy files to remote systemsTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>The remote command execution program Tb4b4b4<Tff7b72codeTb4b4b4>rnxTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> that let's you run commands and programs and retrieve output from remote systemsTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>All tools, including Tb4b4b4<Tff7b72codeTb4b4b4>rnxTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> and Tb4b4b4<Tff7b72codeTb4b4b4>rncpTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4>, work reliably and well even over very low-bandwidth links like LoRa or Packet Radio.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72h2Tb4b4b4>Programs Using ReticulumTb4b4b4<Tb4b4b4/Tff7b72h2Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>If you want to quickly get an idea of what Reticulum can do, take a look at the following resources.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>For an off-grid, encrypted and resilient mesh communications platform, see Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/markqvist/NomadNet"Tb4b4b4>Nomad NetworkTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>The Android, Linux and macOS app Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/markqvist/sideband"Tb4b4b4>SidebandTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> has a graphical interface and focuses on ease of use.Tb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/markqvist/lxmf"Tb4b4b4>LXMFTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> is a distributed, delay and disruption tolerant message transfer protocol built on ReticulumTb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72h2Tb4b4b4>DependenciesTb4b4b4<Tb4b4b4/Tff7b72h2Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>The installation of the default Tb4b4b4<Tff7b72codeTb4b4b4>rnsTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package requires the dependencies listed below. Almost all systems and distributions have readily available packages for these dependencies, and when the Tb4b4b4<Tff7b72codeTb4b4b4>rnsTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package is installed with Tb4b4b4<Tff7b72codeTb4b4b4>pipTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4>, they will be downloaded and installed as well.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/pyca/cryptography"Tb4b4b4>PyCA/cryptographyTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/al45tair/netifaces"Tb4b4b4>netifacesTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tff7b72liTb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/pyserial/pyserial"Tb4b4b4>pyserialTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72liTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72ulTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>On more unusual systems, and in some rare cases, it might not be possible to install or even compile one or more of the above modules. In such situations, you can use the Tb4b4b4<Tff7b72codeTb4b4b4>rnspureTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package instead, which require no external dependencies for installation. Please note that the contents of the Tb4b4b4<Tff7b72codeTb4b4b4>rnsTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> and Tb4b4b4<Tff7b72codeTb4b4b4>rnspureTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> packages are Tb4b4b4<Tff7b72emTb4b4b4>identicalTb4b4b4<Tb4b4b4/Tff7b72emTb4b4b4>. The only difference is that the Tb4b4b4<Tff7b72codeTb4b4b4>rnspureTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package lists no dependencies required for installation.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>No matter how Reticulum is installed and started, it will load external dependencies only if they are Tb4b4b4<Tff7b72emTb4b4b4>neededTb4b4b4<Tb4b4b4/Tff7b72emTb4b4b4> and Tb4b4b4<Tff7b72emTb4b4b4>availableTb4b4b4<Tb4b4b4/Tff7b72emTb4b4b4>. If for example you want to use Reticulum on a system that cannot support Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/pyserial/pyserial"Tb4b4b4>pyserialTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>, it is perfectly possible to do so using the Tb4b4b4<Tff7b72codeTb4b4b4>rnspureTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package, but Reticulum will not be able to use serial-based interfaces. All other available modules will still be loaded when needed.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>Tb4b4b4<Tff7b72strongTb4b4b4>Please Note!Tb4b4b4<Tb4b4b4/Tff7b72strongTb4b4b4> If you use the Tb4b4b4<Tff7b72codeTb4b4b4>rnspureTb4b4b4<Tb4b4b4/Tff7b72codeTb4b4b4> package to run Reticulum on systems that do not support Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"https://github.com/pyca/cryptography"Tb4b4b4>PyCA/cryptographyTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>, it is important that you read and understand the Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"crypto.html"Tb4b4b4>Cryptographic PrimitivesTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4> section of this site.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72h2Tb4b4b4>PerformanceTb4b4b4<Tb4b4b4/Tff7b72h2Tb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>Reticulum targets a Tb4b4b4<Tff7b72emTb4b4b4>veryTb4b4b4<Tb4b4b4/Tff7b72emTb4b4b4> wide usable performance envelope, but prioritises functionality and performance over low-bandwidth mediums. The goal is to provide a dynamic performance envelope from 250 bits per second, to 1 gigabit per second on normal hardware.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72pTb4b4b4>Currently, the usable performance envelope is approximately 150 bits per second to 1200 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised until the wire format and API has been locked in.Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tff7b72p Te6edf3alignTff7b72=Ta5d6ff"right"Tb4b4b4>Tb4b4b4<Tff7b72a Te6edf3hrefTff7b72=Ta5d6ff"hardware.html"Tb4b4b4>Next Topic: Supported HardwareTb4b4b4<Tb4b4b4/Tff7b72aTb4b4b4>Tb4b4b4<Tb4b4b4/Tff7b72pTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72bodyTb4b4b4>
Tb4b4b4<Tb4b4b4/Tff7b72htmlTb4b4b4>
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────